improving documentation #7
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
jakobtroidl
commented
Jun 27, 2022
jakobtroidl
commented
- added hint that bucket must be public
- mentioned not to use dashes in bigtable name
clarified where to make resource adjustments.
added service account roles to description
clarified documentation
akhileshh
reviewed
Jun 27, 2022
| @@ -83,7 +85,7 @@ Pods should now be in `Running` status, provided there were no issues. Run the f | |||
| ```shell | |||
| $ kubectl exec -ti deploy/master -- bash | |||
| // now you're in the container | |||
| > ingest graph <unique_test_bigtable_name> datasets/test.yml --test | |||
| > ingest graph <unique_test_bigtable_name> datasets/test.yml --test // avoid dashes in <unique_test_bigtable_name>, neuroglancer can't handle them | |||
There was a problem hiding this comment.
I think it might be cave code that has issues with dashes. It is better to just say use underscores instead.
akhileshh
reviewed
Jun 27, 2022
| @@ -64,6 +64,8 @@ and link the image and tag in `values.yaml` (refer to `example_values.yaml`). | |||
|
|
|||
| > NOTE: Depending on your dataset, you will need to figure out the optimal limits for cpu and memory in your worker deployments. To do that adjust the `count` and `machine` variables in terraform.tfvars. It can vary with chunk size, size of supervoxels (atomic semgents in layer 1), number of edges per chunk and so on. | |||
|
|
|||
| > NOTE: The bucket storing the edges, components etc must be public. The bucket is also linked in `example_values.yaml` [here](https://github.com/seung-lab/CAVEpipelines/blob/4d0ee8d98fb8891074d6e1115ed9394e6a021cd5/helm/pychunkedgraph/example_values.yaml#L29). | |||
There was a problem hiding this comment.
The bucket with segmentation data needs to be public, not the one with edges and components. They do not need to be in the same bucket. It needs to be public for neuroglancer to read.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.